home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1998 March / EnigmA AMIGA RUN 25 (1997)(G.R. Edizioni)(IT)[!][issue 1998-03].iso / recent2 / joinreplace.readme < prev    next >
Text File  |  1998-02-19  |  7KB  |  160 lines
  1. Short:    V1.18 powerful Join replacement
  2. Author:   stoecker@rcs.urz.tu-dresden.de (Dirk Stoecker)
  3. Uploader: stoecker@rcs.urz.tu-dresden.de (Dirk Stoecker)
  4. Version:  1.18
  5. Type:     util/misc
  6. Kurz:     Join Ersatz mit vielen Funktionen
  7.  
  8. Advantages of this Join:
  9.   - it can be called like original Join - complete replacement
  10.   - it can take the filenames from a filelist
  11.   - it can built the filenames out of a file-splitter name description
  12.   - it supports patterns
  13.   - it can add the files to an existing source (useful when low diskspace)
  14.   - it is able to delete source-files when needed
  15.   - it has a lot of text join options (AMIGAGUIDE, HEADER, NAMEHEADER)
  16.   - it is in the Public Domain (including sources)
  17.   - it is really fast
  18.   - it also works with low memory, but is slower then
  19.   - it can be started from Workbench as well as from CLI
  20.  
  21. Join needs OS 37 (2.0) or later OS versions!
  22. Of course this Join is reentrant (pure bit) like the original one.
  23.  
  24. There is one main difference between my and original Join: My Join brings
  25. output. When you do not like that, use QUIET option to turn it off.
  26.  
  27. On workbench start you only need to specify normal CLI command line as
  28. tooltype. All tooltypes of program icon (when exists) or project icons
  29. are scanned and used. When an error occurs, the left tooltypes are not
  30. scanned! In the Icons directory of this archive are one program and one
  31. project icon as examples.
  32.  
  33. USAGE:
  34.   Join FILE/M,AS=TO/K/A,FILELIST/K,SPLITTED/K,PAT=PATTERN/K,OUTPUT/K,
  35.        AG=AMIGAGUIDE/S,HEADER/S,NAMEHEADER/S,ADD/S,DEL=DELSOURCE/S,
  36.        QUIET/S,ALL/S,NOPAT=NOPATTERN/S:
  37.   FILE       files, which should be joined
  38.   AS=TO         destination file
  39.   FILELIST   takes the filenames out of a file (every line contains
  40.              a complete filename)
  41.   SPLITTED   allows joining splitted files, data has to look like:
  42.              <filename>[,<first number>[,<last number>]], filename has
  43.              to hold ONE format string like %ld,%03ld,%lx,%2lx,
  44.              numbers have to be decimal
  45.  
  46.   PATTERN    gives a pattern the filename must match
  47.   OUTPUT     speciefies output path
  48.  
  49.   AMIGAGUIDE at the start of every file @node "filename" and at the
  50.              end @endnode is inserted
  51.   HEADER     /* ======== ... ========= */ is inserted at filestart
  52.   NAMEHEADER /* ===... filename ...=== */ is inserted at filestart
  53.   ADD        adds the files to an existing destination file
  54.   DELSOURCE  deletes the sourcefiles
  55.   QUIET      brings no output
  56.   ALL        scan into directories
  57.   NOPATTERN  take names as given
  58.  
  59. There are three modes:
  60. 1) FILE - This mode joins files, which are given in command line. Standard
  61. Join does this always. The files are joined in the way they are given.
  62.  
  63. Example: Join xaa xab xac xad xae TO Archiv.lha
  64.  
  65. 2) FILELIST - Equals FILE mode, but the filenames are in a file, which
  66. may be specified after FILELIST keyword. In the filelist the must be one
  67. filename per line.
  68.  
  69. Example: Join FILELIST JoinList TO Archiv.lha
  70. [Where JoinList ist a file like that:
  71. xaa
  72. xab
  73. xac
  74. xad
  75. xae
  76. ]
  77.  
  78. Such filelists may for example be generated with List command:
  79.  List <pattern> >RAM:filelist NOHEAD QUICK
  80. or
  81.  List <pattern> >RAM:filelist LFORMAT "%s"
  82.  
  83. Later on you may sort it with Sort RAM:filelist RAM:filelist
  84.  
  85. 3) SPLITTED - This mode is used, when joining splitted files. The string
  86. passed with SPLITTED keyword contains of 3 parts:
  87.  
  88. - file-name of splitted files including place-holders for numbers:
  89.    Archiv.%03ld   describes files named Archiv.000, Archiv.001, Archiv.010
  90.    Archiv.%ld     describes files named Archiv.0, Archiv.1, Archiv.2
  91.  
  92.   Allowed place holders are %lx, %ld, %lu, %lc (not very useful). See
  93.   RawDoFmt or printf documentation to find out, what they and the format
  94.   flags (%03ld, %3ld, $-3ld) do.
  95.  
  96. - After the filename you may specify the number, where the splitted files
  97.   start. This is optional, the default is 0. The filename and the number
  98.   are seperated by a ','.
  99.  
  100. - The last part is the number, where the list ends. This is optional too.
  101.   At default Join finishs, when it could not load a file. When the last
  102.   number is given, missing files are skipped instead. You need to specify
  103.   first number always, when defining end number. The numbers are seperated
  104.   by ',' again.
  105.  
  106. Example: There are files f0, f1, f2, f3, f5, f9, f10
  107.  
  108. Join f%ld,1,10 TO f   joins files f1 f2 f3 f5 f9, f10 to file f
  109.                       (f4, f6, f7, f8 are skipped)
  110.  
  111. Join f%ld,2 TO f      joins files f2 f3 to file f
  112.                       (f4 is missing -> end)
  113.  
  114. Join f%ld TO f        joins file f0 f1 f2 f3 to f
  115.  
  116. Additional to these three modes, there are some goodies:
  117.  
  118. - PATTERN allows to specify a special pattern, the filenames should match.
  119.   This is useful sometimes, when patterns cannot be described with normal
  120.   filename.
  121.   Example: join all text files on a device including sub directories.
  122.     Join #? ALL TO AllTexts PATTERN #?.TXT
  123. - OUTPUT lets you specify any standard Amiga file for output (f.e. "RAM:Out"
  124.   or "CON:0/0/640/200/JoinOutput/AUTO/WAIT/CLOSE"). This is most useful for
  125.   Workbench use.
  126.  
  127. - AMIGAGUIDE allows to insert at start of every file @node "filename" and
  128.   at the end @endnode. This gives you a file, where all joined files are
  129.   Amigaguide nodes.
  130. - HEADER inserts /* ======== ... ========= */ as seperation between the
  131.   files.
  132. - NAMEHEADER inserts /* ===... filename ...=== */ before every joined file.
  133. - ADD adds the files to an existing destination file.
  134. - DELSOURCE deletes the sourcefiles after they are joined.
  135. - QUIET suppresses output. Join is completely silent with that keyword.
  136. - ALL allows to scan into directories, when filenames contains patterns.
  137. - NOPATTERN turns of pattern matching. This may be useful, when filenames
  138.   already contain patterns.
  139.  
  140. Note: Pattern matching works for all three modes!
  141.  
  142. This program is in the public domain. Use it as you want, but WITHOUT ANY
  143. WARRANTY!
  144.  
  145. Please report me bugs, comments, suggestions and problems. If possible
  146. write a little mail if you use the program sometimes. If there are some
  147. Enforcer hits or other problems report them as good as possible.
  148.  
  149. Please contact me:
  150.  
  151. ****************************************************************************
  152. * snail-mail:                  * e-mail:                                   *
  153. *   Dirk Stoecker              *   stoecker@rcs.urz.tu-dresden.de          *
  154. *   Geschwister-Scholl-Str. 10 *   stoecker@amigaworld.com                 *
  155. *   01877 Bischofswerda        * world wide web:                           *
  156. *   GERMANY                    *   http://home.pages.de/~Gremlin/          *
  157. * phone:                       * pgp key:                                  *
  158. *   GERMANY +49 (0)3594/706666 *   get with finger or from WWW pages       *
  159. ****************************************************************************
  160.